package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.EmpArchivesAddDTO;
import org.jsola.hr.dto.EmpArchivesUpdateDTO;
import org.jsola.hr.query.EmpArchivesQuery;
import org.jsola.hr.vo.EmpArchivesListVO;
import org.jsola.hr.vo.EmpArchivesVO;

import java.util.List;

/**
 * 员工档案信息
 *
 * @author zhr
 */
@Api(tags = "hr-员工档案信息")
public interface IEmpArchivesControllerAPI {

    /**
     * 新增员工档案信息
     * @param empArchivesAddDTO 员工档案信息新增实体
     * @return 员工档案信息展示对象
     */
    @ApiOperation(value = "新增员工档案信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empArchivesAddDTO", dataType = "EmpArchivesAddDTO", value = "新增员工档案信息", paramType = "body")
    })
    Result<EmpArchivesVO> save(EmpArchivesAddDTO empArchivesAddDTO);


    /**
     * 修改员工档案信息
     * @param empArchivesUpdateDTO 员工档案信息
     * @return 更新数量
     */
    @ApiOperation(value = "修改员工档案信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empArchivesUpdateDTO", dataType = "EmpArchivesUpdateDTO", value = "修改员工档案信息", paramType = "body")
    })
    Result<Integer> update(EmpArchivesUpdateDTO empArchivesUpdateDTO);




    /**
     * 删除单个员工档案信息，彻底删除
     * @param empArchivesId 员工档案信息id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个员工档案信息，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empArchivesId", dataType = "String", value = "员工档案信息id", paramType = "path")
    })
    Result<Integer> delete(String empArchivesId);


    /**
     * 批量删除员工档案信息，彻底删除
     * @param empArchivesIds 员工档案信息id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除员工档案信息，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empArchivesIds", dataType = "String[]", value = "员工档案信息id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] empArchivesIds);


    /**
     * 根据员工档案信息id查询员工档案信息详情
     * @param empArchivesId 员工档案信息id
     * @return 员工档案信息详情
     */
    @ApiOperation(value="根据员工档案信息id查询员工档案信息详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empArchivesId", dataType = "String", value = "员工档案信息id", paramType = "path")
    })
    Result<EmpArchivesVO> findById(String empArchivesId);


    /**
     * 查询员工档案信息
     * @param empArchivesQuery 员工档案信息查询参数
     * @return page
     */
    @ApiOperation(value="查询员工档案信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empArchivesQuery", dataType = "EmpArchivesQuery", value = "员工档案信息查询参数", paramType = "query")
    })
    Result<List<EmpArchivesListVO>> listAll(EmpArchivesQuery empArchivesQuery);


     /**
     * 分页查询员工档案信息
     * @param empArchivesQuery 员工档案信息查询参数
     * @return page
     */
    @ApiOperation(value="分页查询员工档案信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empArchivesQuery", dataType = "EmpArchivesQuery", value = "员工档案信息查询参数", paramType = "query")
    })
    Result<Page<EmpArchivesListVO>> page(EmpArchivesQuery empArchivesQuery);


}

